Refund order

Refunds the payments of a fulfilled order for the authenticated customer. Only the tenders change (REFUNDED); the order status and fulfillment_status stay as they are, so no webhook is sent to the POS. Only orders that are already fulfilled, and whose resolved_at is within the last 24 hours, can be refunded from Storefront. Calling it again answers 200 with the order.

Requires a Storefront API access token from Token exchange.

In @fire-spark/storefront, call order.refund(): it checks the order is delivered, voids the device charges and calls this endpoint with type: "REFUND". order.refundOrder() still calls it without a body.

Unfulfilled orders cannot be refunded here. Cancel them with Cancel order before fulfillment.

Path parameters

Parameter	Required	Description
`id`	Yes	External order identifier

Request body

Optional, same fields as Cancel order. type can only be REFUND. A reported REVERSED tender ends REFUNDED.

Request

curl -X POST "https://firespark.cloud/api/storefront/v1/orders/ord-48291/refund" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "type": "REFUND" }'

Response

Returns 200 with the order and its refunded tenders.

{
  "data": {
    "id": "ord-48291",
    "status": "COMPLETED",
    "fulfillment_status": "FULFILLED",
    "payment_status": "REFUNDED"
  }
}

Error responses

Status	Description
`400`	Malformed body or unknown `type`
`401`	Missing or invalid access token, or `device` with a bad secret or not linked
`403`	`device` of another workspace (`DEVICE_SCOPE_MISMATCH`)
`404`	Order not found
`422`	Order is not fulfilled (`ORDER_NOT_FULFILLED`), the 24-hour window expired (`REFUND_WINDOW_EXPIRED`), the order cannot be refunded, `type` is not `REFUND` (`TYPE_ENDPOINT_MISMATCH`), or a reported tender is unknown

API Documentation

Endpoints

Guides

Resources

Path parameters

Request body

Request

Response

Error responses

​Path parameters

​Request body

​Request

​Response

​Error responses

Path parameters

Request body

Request

Response

Error responses